home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 17 / CU Amiga Magazine's Super CD-ROM 17 (1997)(EMAP Images)(GB)[!][issue 1997-12].iso / CUCD / Games / Team17-HDinst / ProjectX / jst.readme < prev    next >
Text File  |  1997-10-01  |  12KB  |  284 lines
  1. Short: JOTD Startup for JF Fabre HD Installs
  2. Type: game/patch
  3. Author: jffabre@ensica.fr (Jean-François Fabre)
  4. Uploader: jffabre@ensica.fr (Jean-François Fabre)
  5.  
  6.  
  7. As you could notice, I created and uploaded many HD-Install & fix programs for
  8. non dos games, but all of them were standalone, and in case of an error in the
  9. general loader routines, I had to remake the loader (relink) and upload again.
  10.  
  11. Bert Jahn had developped WHDLoad, which solves this problem because it allows to
  12. load small, game-specific loaders and run them using its own degrade/hd/dos code.
  13. This technique allows easy updates in case of bugs or new functionnalities.
  14.  
  15. That's what I decided to do myself. JST was born from a 8-hour adaptation of
  16. my link library. It's an equivalent to WHDLoad but a bit more powerful
  17. , as the system can be called in the slave loader, messages can be printed,
  18. a gui can be opened, there are lots of cool functions, and much more.
  19. It also allows easier programming of loaders (but WHDLoad is still cool!)
  20.  
  21. WHY THIS PROGRAM HERE:
  22.  
  23. Alone, this program is useless. I uploaded it because it's needed but not included
  24. in my new installs and also Keith Krellwitz ones, because he uses my code.
  25. This allows to save space in the archives and avoids leaving old versions of JST
  26. around if a bug shows up.
  27.  
  28. JOTD HD Startup is © 1995-1997 Jean-François FABRE
  29. JOTDStartup is © 1997 Jean-François FABRE
  30.  
  31.  
  32. JOTDStartup is SHAREWARE!
  33.  
  34. From V0.3 I decided to ask a fee of US$10, 20DM, 7£ or 50FF to be able to become
  35. a registered user. However, I will register whoever I think he or she did something
  36. cool for me (already sent disks, money, sports cars, Sandra Bullock clones...).
  37. Lots of people are already on the list. If you think I forgot you, contact me.
  38.  
  39. To register, send the money to:
  40.  
  41. Jean-François Fabre
  42. 19 Rue Emile Duploye
  43. 34500 BEZIERS
  44.  
  45. Specify your e-mail or send a blank disk with the money (for non-internet users),
  46. and I'll send you the registered version of JST (+the latest installs for the
  47. ones who sent a floppy)
  48.  
  49.  
  50. If you think this is too expensive, you can use the "limited" shareware version.
  51. It has no limitations compared to older free releases but the new features will
  52. be reserved to registered version. However, if I fix a bug, it will be fixed in
  53. both registered and shareware version of course.
  54. All the future loaders will be compatible with the limited version.
  55.  
  56. I hope you understand JST and all the loaders were hard work for me, that's why
  57. I decided it.
  58. The money will be shared between me and the loaders programmers using JST
  59. (2 for the moment, including me).
  60.  
  61.  
  62. OPTIONS:
  63.  
  64. You can select the options:
  65.  
  66. - From the CLI by typing the arguments (JST ? for help)
  67. - From the WB by activating/disabling the tooltypes
  68.  
  69. Some have effect only on loaders that support them. They will be noted are *OPTIONAL*
  70. Some have effect on all loaders. They're noted as *GENERAL*
  71.  
  72. Here's a short description of the options.
  73.  
  74. - OBJNAME="object": lets you specify an object name (icon launch).
  75.  
  76. - NTSC (GENERAL): default for loader is PAL. NTSC changes this to NTSC (really?)
  77.  
  78. - TRAINER (OPTIONAL): activates trainer when there is one. It can be infinite lives, time, etc...
  79.  
  80. - QUIET (GENERAL): displays nothing and opens no window. No error messages, and no author message.
  81.   Be sure that everything works OK before selecting this one.
  82.  
  83. - NOCACHES (GENERAL): Sets CACR to 0. All caches are disabled. 68060 supported.
  84.  
  85. - NOFAST (GENERAL): Always allocates extension memory
  86.   from chip memory. If you got crap sprites, this could help. USeless in the case of 512K mem games.
  87.  
  88. - HDLOAD (GENERAL): to save some memory, you can load from HD instead of caching all the files in RAM.
  89.   It works for diskfiles and normal files.
  90.   Useless in games with only 1 diskfile, use LOWMEM instead.
  91.  
  92. - LOWMEM (OPTIONAL): will not cache diskfiles in memory. Read directly from disk. Useful if you've
  93.   got a A1200/020/NoFast. With normal files, LOWMEM consumes even less memory than HDLOAD. Some
  94.   loaders may bring up and error message or crash with an exception.
  95.   In that case they don't support this option yet :)
  96.  
  97. - NOOSSWAP (OPTIONAL): Disables in game HD loads/saves. Depending on the loaders, NOOSSWAP
  98.   will try to access the floppy when you try to save/load a game, or will do nothing.
  99.   If you don't select NOOSSWAP, if the game has some data to write, it will do it on your
  100.   hard drive. It's rather safe (I've been using it for a while now) but you should avoid
  101.   filesystems or disk caches that perform copyback caching (AFS, possible in Dynamicache).
  102.   This is not generally harmful, except if you quit by a reset or the game locks. In that
  103.   case, your hard drive can be unvalidated.
  104.  
  105. - DELAY (GENERAL): Waits 1 second before starting the game. Useful if you've just saved the
  106.   promotion prefs (JST opens an intuition screen) on a screen promoter like NewMode. You only
  107.   have to save it once, but if you don't specify DELAY the first time you run JST.
  108.   Once the prefs saved to disk properly, you can remove the DELAY option. You can also edit
  109.   a program, change its name to HDStartup in the promoter window and save (NewMode).
  110.   You should not promote the HDStartup screen. It's useless and can create problems. You won't be
  111.   able to run a PAL game in multiscan anyway...
  112.   This DELAY option can also be useful for low speed media. It allows the drive to stop.
  113.  
  114. - SAVEDIR (OPTIONAL): allows the user to specify a directory where the game data like hiscores
  115.   or savegames will be saved/loaded. Some loaders with HD saves don't support it yet.
  116.   This function is only available to registered users.
  117.  
  118. - BENICE (GENERAL): This one is for compatibility purposes, but "clean" installs should not
  119.   use it, because it leaves ExecBase intact, and does not switch off the DMA. Leaving both
  120.   can be unreliable and can trigger 81000005 GURUs in the case the loader still uses system
  121.   routines (which is not recommended, but it's up to the programmer. I generally remove all
  122.   system code in the game), and freezes if DMA is not deactivated/set properly by the game.
  123.  
  124. Some options are here for debug and developpement purpose only:
  125.  
  126. - DEBUG (GENERAL): useful only for bug reports. Makes a memory image on exit. Can be FULL or REGS
  127. - LEAVEVBR (GENERAL): useful only for debugging purposes, and with a debugger such as Action-Replay,
  128.           HRTMon or ThrillKill. Don't select it unless you want to debug.
  129. - TEST (GENERAL): The loader will not start. Only the options selected will be displayed.
  130. - VERBOSE (GENERAL): The loader will display information while initializing (memory, files...)
  131.  
  132. Examples from CLI:
  133.  
  134. JST MagicPocketsHD NOCACHES DELAY NTSC
  135. JST HookHD NOFAST HDLOAD SAVEDIR=ram: (registered users only can use SAVEDIR)
  136.  
  137.  
  138. PROBLEMS:
  139.  
  140. Some error messages can occur before or after the game has started:
  141.  
  142. - Object is not relocatable: the game-specific loader must not address variables in an
  143.   absolute way (this error is more for programmers)
  144.  
  145. - Invalid Object: someone tried to load non-loader objects or other files
  146.  
  147. - Not enough memory: try to free some memory. Playing with NOFAST and HDLOAD and boot without
  148.   startup-sequence can help too.
  149.  
  150. - Unsupported version: some games exist in different versions. I try to support some of them,
  151.   but if the program does not recognize the version, it can display this message (it can crash too!).
  152.  
  153. - Exception: <cryptic message> : some illegal instruction was encountered while the game executes.
  154.   Try NOCACHES and NOFAST to see if it helps. Else report me/patch author the error with accuracy.
  155.  
  156. - Wrong virtual disk ID: patch error. Contact author.
  157.  
  158. - Diskfile not found, Disk Read Error: in HDLOAD mode, a file is missing.
  159.  
  160. - GetDiskPointer called while in LOWMEM mode: LOWMEM is not possible with this loader.
  161.  
  162. - Not enough memory while you've got plenty: check the priority of your different
  163.   memory expansion card, because JST uses MEMF_REVERSE, and maybe that's the cause. Use the
  164.   VERBOSE option to see what's the problem.
  165.  
  166. If the game simply hangs or resets, check that you don't have some MMU related program
  167. running (enforcer, VMM...) or low level patches like Fastexec. My patches are reported
  168. to work with softkicked amigas, though.
  169. Some versions of the 68060.library can bring up problems too (gfx errors)
  170.  
  171. The game can crash if it finds an exception and there is not enough memory to restore the
  172. system and display the exception message. Buy some more mem :-)
  173.  
  174.  
  175. History:
  176.  
  177. V0.5c:
  178.        - Bugfix in ReadFileHD for getlength command
  179.        - ReadUserDir() function added
  180.        - Now battery backed up clock is reloaded only on a quit from the game
  181.  
  182. V0.5b:
  183.        - bugfix in SaveOSData: ExecBase was not cleared if VBR was 0 or LEAVEVBR was on
  184.        - bugfix in arguments parsing on shareware version. Almost all tooltypes did not work!
  185.        - stack relocated to top of used chipmem in SaveOSData: Agony, BodyBlows original
  186.          & BodyBlows Galactic work on a standard A1200/020/NoFast.
  187.        - all registers D0-A6 set to 0 in SaveOSData
  188.        - sprite dma disabled at bootup to avoid some display corruption
  189.  
  190. V0.5a:
  191.        - DMA set/clr bugfix in os swap routine
  192.        - WaitBOF function added (not functionnal yet)
  193.        - Better WaitBlit() routine
  194.  
  195. V0.5:
  196.        - Bugfix: intuition screen was not opened!
  197.        - More accurate exception handling (useful for coders/bug reports)
  198.        - Added TPWM decrunch routine (experimental, not tested)
  199.        - Changed ImploderDecrunch(). Now only registers D2-D5/A2-A4 are saved.
  200.  
  201. V0.4b:
  202.        - Sprites/display are reset better when an OS swap occurs (HDLOAD/LOWMEM mode)
  203.  
  204. V0.4a:
  205.        - JST now opens an intuition screen of 4 colors (vs 16 in older versions)
  206.        - Now JST does not allow system calls after SaveOSData (programmers only)
  207.        - BENICE tooltype added for compatibilty (users who have problems with old loaders)
  208.        - Removed a bug in argument parsing from CLI
  209.  
  210. V0.4:
  211.        - Now JST loads the clock from battery backed up clock if found (registered only)
  212.  
  213. V0.3 : JST is now SHAREWARE. Some features are only accessible to registered users.
  214.  
  215.        - 1.3 compatibility restored. SAVEDIR still unsupported
  216.        - VERBOSE tooltype added.
  217.        - RNC\02 unpack method added to RNCDecrunch()
  218.        - Alloc24BitMem() function added (for some games which do not like 32 bit fastmem)
  219.        - Read/Write/DeleteUserFileHD() functions added to support SAVEDIR
  220.        (developper(s?) please update your loaders which load/save user data to disk)
  221.        - Slightly changed DMA handling on os swaps
  222.        - Fixed a bug in dump register functionnality (DEBUG option)
  223.        - Now the display comes up and the dumps are written after (DEBUG option).
  224.        - SAVEDIR tooltype added (registered only)
  225.  
  226. V0.2e: internal release
  227.  
  228. V0.2d: NOOSSWAP no longer forbids HDLOAD or LOWMEM. It's now a user flag
  229.  
  230. V0.2c:
  231.        - Fixed bug in LoadDisksFromName (Cadaver)
  232.        - Changed task name to "JOTDStartup"
  233.  
  234. V0.2b:
  235.        - Changed intuition screen depth from 8 colors to 16
  236.  
  237. V0.2a:
  238.        - fixed bug with LoadDisksIndex and LOWMEM (Superfrog intro)
  239.  
  240. V0.2: first aminet release, few details changed
  241.  
  242. V0.1: developper release
  243.  
  244.  
  245. STILL TO DO:
  246.  
  247. - Fix a bug in memory allocation which prevents the use of fast memory in some cases
  248.  
  249. - Prefetch diskfile data in memory to avoid too much os swaps in LOWMEM mode
  250.   (Registered users only)
  251.  
  252. - Some other secret cool features for registered version :)
  253.  
  254. DISCLAIMER:
  255.  
  256. I'm not responsible for any damage caused directly or indirectly by this piece
  257. of software.
  258.  
  259. DISTRIBUTION:
  260.  
  261. The shareware version of JST and my HD work can be distributed freely. However, I'd appreciate
  262. that you drop me a line if you include it in a coverdisk or PD collection.
  263. If you like (or you dislike) this piece of software, you can e-mail me.
  264.  
  265. The registered version of JST should NOT be distributed.
  266.  
  267. ME:
  268.  
  269. Visit my patch page, where all my HD work is gathered, along with some other
  270. quality installers (all for original software), and some other interesting
  271. related freeware stuff:
  272.  
  273. http://www.ensica.fr/~jffabre/patches.html
  274.  
  275. And my home page (totally stupid stuff):
  276.  
  277. http://www.ensica.fr/~jffabre/ (english)
  278. http://www.ensica.fr/~jffabre/index_fr.html (french)
  279.  
  280. E-mail: jffabre@ensica.fr
  281.  
  282.  
  283. Jeff
  284.